home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-20 / bpq406e.zip / PROGS.DOC < prev    next >
Text File  |  1992-09-05  |  10KB  |  320 lines
  1.  
  2. The following programs are provided.
  3.  
  4. BPQCODE.EXE
  5.  
  6. The TSR version of the packet switch. It provides a NET/ROM compatible
  7. packet switch, and an interface to application-level software (such as a BBS).
  8.  
  9.  
  10. SWITCH.EXE
  11.  
  12. This is a foreground version of BPQCODE. It is intended to run only as
  13. a packet switch, and not to support an application system (eg BBS). A
  14. simple terminal program (equivalent to PAC4) is built in, as is the
  15. SYSOP handler from the Data Engine version of the switch. The diffences
  16. from BPQCODE are listed below:
  17.  
  18.     BPQCFG.TXT
  19.  
  20.     This can be the same as for the normal version. The code will assume
  21.     NODE=1 and BBS=0, whatever is entered. 
  22.  
  23.  
  24.     Terminal support.
  25.  
  26.     See PAC4 below for details. Ctrl/Y shuts down the whole switch.
  27.  
  28.  
  29.     SYSOP Commands.
  30.  
  31.     The SYSOP feature is similar to SYSOPH, but the password protection
  32.     works rather differently. To enter SYSOP mode, enter PASSWORD. If 
  33.     you are using the console, the switch will respond Ok, and enter 
  34.     SYSOP mode. If you are accessing the system remotely, it will repond 
  35.     with 5 random numbers. You must reenter PASSWORD, this time followed 
  36.     by the corresponding characters from the password string contained 
  37.     in the file PASSWORD.BPQ. If these are correct the switch responds 
  38.     OK, otherwise it ignores the message.
  39.  
  40.     So, if the password string is ABCDEFGHIJKLM the following is a
  41.     typical sequence:
  42.  
  43.         PASSWORD
  44.         BPQ:G8BPQ} 04 02 05 06 03
  45.         PASSWORD DBEFC
  46.         BPQ:GBBPQ} Ok
  47.  
  48.     Note that the password is converted to upper case before testing, so 
  49.     PASSWORD.BPQ should contain upper case letters or digits. It should
  50.     not contain spaces or other special characters.
  51.  
  52.     There are a number of extra SYSOP commands. These were added primarily
  53.     for the Data Engine version, where experimenting with parameters is 
  54.     rather more difficult, but I've left them in this version as well.
  55.     
  56.         Command        Corresponding BPQCFG parameter
  57.  
  58.         OBSINIT            OBSINIT
  59.         OBSMIN            OBSMIN
  60.         NODESINT        NODESINTERVAL
  61.         L3TTL            L3TIMETOLIVE 
  62.         L4RETRIES        L4RETRIES
  63.         L4TIMEOUT        L4TIMEOUT
  64.         T3            T3
  65.         IDLETIME        IDLETIME
  66.         LINKEDFLAG        ENABLE_LINKED
  67.         IDINTERVAL        IDINTERVAL
  68.         MINQUAL            MINQUAL
  69.         FULLCTEXT        FULL_CTEXT
  70.         HIDENODES        HIDENODES
  71.         L4DELAY            L4DELAY
  72.         L4WINDOW        L4WINDOW
  73.         BTINTERVAL        BTINTERVAL
  74.  
  75.     There is also one commend which isnt in the DE version - SAVENODES.
  76.  
  77.  
  78.  
  79.  
  80. BPQCFG.EXE
  81.  
  82. This program converts the configuration file BPQCFG.TXT to a binary file
  83. (BPQCFG.BIN) for use by the switch software. It must be run after any
  84. change to BPQCFG.TXT.
  85.  
  86.  
  87.  
  88. BPQNODES.COM
  89.  
  90.  
  91. This program dump the ROUTES and NODES tables to a file (BPQNODES). This
  92. file is then used to initialise the above tables when the switch is 
  93. reloaded. It should be run before reloading the switch, and if possible
  94. at regular intervals, so that if the system crashes, it comes back with
  95. a reasonably up-to-date view of the network. Many BBS systems allow you
  96. to run a program as part of the forwarding cycle, or at specified times.
  97.  
  98.  
  99. It is possible to edit the BPQNODES file. This provides a way of defining
  100. Route Qualities, etc. without changing BPQCFG.TXT, or using SYSOPH.
  101.  
  102. The file format is: ( {} indicates optional entries - don't include the{})
  103.  
  104. ROUTE ADD CALL P QUAL {!} {VIA DIGI1 {DIGI2}}
  105.  
  106. where P is the port, QUAL the Quality, and the optional ! indicates a locked
  107. route. Up to 2 DIGIS may be specified. 
  108.  
  109. NODE ADD ALIAS:CALL CALL-1 P QUAL {!} {CALL-2 P QUAL {!} } {CALL-3 ....}
  110.  
  111. where CALL-1, CALL-2, CALL-3 are up to 3 alternate routs, which must be
  112. defined (by ROUTES config entries or ROUTE ADD) before being used.
  113.  
  114. Although locked nodes are allowed, I strongly recommend  that they are used
  115. only in exceptional circumstances (eg when using a digi'ed route). Note also
  116. that a locked route to a node will be removed if the system finds 3 higher
  117. quality routes to it.
  118.  
  119.  
  120. Lines beginning with ; are treated as comments, and fields should be separated
  121. by one (and only one) space.
  122.  
  123.  
  124.  
  125.  
  126. BPQDUMP.COM
  127.  
  128.  
  129. BPQDUMP.COM  is a simple program to dump my code to a file to aid diagnosis 
  130. of fault conditions. It creates a file in the current directory called
  131. BPQDUMP (about 98k).
  132.  
  133. If run without a parameter, it dumps immediately.
  134.  
  135. If a param is specified, it will loop until the free buffer count drops below
  136. 20 ( the point when the code starts to shut down), then dumps and exits. Note
  137. this mode must only be run in a desqview window.
  138.  
  139.  
  140. eg
  141.  
  142. BPQDUMP        - dumps now
  143.  
  144. BPQDUMP X    - dumps when buffers < 21
  145.  
  146.  
  147.  
  148. PAC2.COM
  149.  
  150.  
  151. PAC2 is a small, simple terminal program, primarily for use with my switch,
  152. but it also works with a normal TNC + COMBIOS. It has one paramter (port
  153. number), so enter PAC2 N, where N is the (virtual) COMBIOS port you want to 
  154. access. The program provides a buffered input line, which allows use of
  155. the editing keys ins, del, cul, cur, etc, It allows logging to disk (CTRL/L
  156. toggles this function on and off), and maintains a simple 'Response Time
  157. Monitor' function - useful for seeing how badly the network is performing!
  158.  
  159. To exit from PAC2, enter CTRL/Y
  160.  
  161.  
  162. PAC4.EXE
  163.  
  164.  
  165. PAC4 is a simple terminal program, which uses the BPQ Host Mode to talk
  166. to the switch. The program provides a buffered input line, which allows use 
  167. of the editing keys ins, del, cul, cur, etc. It allows logging to disk
  168. (CTRL/L toggles this function on and off), and maintains a simple 'Response
  169. Time Monitor' function. A scroll-back buffer is also provided - use PageUp
  170. and PageDown to scroll.
  171.  
  172.  
  173. The program has one required paramter (port number), and a second optional
  174. one (M for mono mode). So possible command lines are:
  175.  
  176.     PAC4 63            ; to use stream 63
  177.  
  178.     PAC4 1 M        ; to use stream 1, if you have a mono monitor.
  179.  
  180. Connection is made to the switch when a message is input. The ESC key 
  181. disconnects you from the switch.
  182.  
  183. Monitoring is toggled on/off using F1. F2 toggles MCOM mode (monitoring of
  184. control frames as well as info frames). F3 allows you to set MMASK. Press
  185. F3, then key up to 4 hex digits, terminated with a newline. Each bit of MMASK
  186. enables the monitoring of the corresponding radio port. Bit 0 enables port
  187. 1, bit 15 port 16. Any combination of bits may be set. The current monitor
  188. settings are displayed on the status line.
  189.  
  190.  
  191. To exit from PAC4, enter CTRL/Y
  192.  
  193.  
  194. SYSOPH.COM
  195.  
  196.  
  197.  
  198. This program allows the manipulation of certain parameters within the switch. 
  199. The program may be run as a normal DOS program, either in a Desqview window
  200. or standalone, or it may run as a TSR. The TSR mode would normally be used
  201. if you were running a BBS system that doesnt need DesqView (eg AA4RE). In
  202. TSR mode, commands cannot be entered locally, and the SAVENODES command
  203. is disabled. It either mode, it may be accessed over the network. 
  204.  
  205. The system has now been modifed to use BPQHOST mode rather than a virtual
  206. TNC2 port. Program SYSOP.COM is withdrawn - the current version is SYSOPH.COM
  207.  
  208.  
  209. Installation.
  210.  
  211. 1. Add a suitible application name as the third APPLICATIONS Param, ie
  212.  
  213.      APPLICATIONS=BBS,,*SYSOP
  214.  
  215.    I suggest you use a name starting with a '*', as this will 'hide' the
  216.    command from the Valid Commands display.
  217.  
  218. 2« Creatσ ß file¼ PASSWORD.BPQ, containing a string of up to 80 characters.
  219.  
  220. 3. Run program SYSOPH, with a single parameter of the stream to be used,
  221.    either on its own, or in a DesqView window. If a second parameter of
  222.    'RESIDENT' is specified, the program will become a TSR routine.
  223.  
  224.  
  225.  
  226. Commands may now be entered directly on the PC, (unless in TSR mode) or
  227. remotely by connecting to the Node, and entering the APPL name (eg *SYSOP).
  228. When accessed remotely, a password prompt is sent, containing 5 random numbers
  229. in the range 1 to the length of the PASSWORD.BPQ string. The first command
  230. entered must be the corresponding five letters from the password string, 
  231. or the user will be disconnected.
  232.  
  233. Available Commands.
  234.  
  235. The following commands are supported:
  236.  
  237. BYE - Disconnect remote user (even if entered from console)
  238.  
  239. TXDELAY
  240. MAXFRAME
  241. FRACK
  242. RESPTIME
  243. PACLEN
  244. RETRIES
  245. QUALITY
  246. PERSIST
  247. TXTAIL
  248. XMITOFF
  249. DIGIFLAG
  250. DIGIPORT
  251. USERS
  252. VALIDCALL
  253. L3ONLY
  254. BBSALIAS
  255. SOFTDCD
  256.  
  257.    The above display or update the parameter for a specified port,
  258.  
  259.    eg   PACLEN 1 100
  260.         PERSIST 2 50
  261.  
  262.    If the third parameter is omitted, the current value is displayed.
  263.  
  264.    Setting XMITOFF will supress all TX activity on a port (including CWID,
  265.    beacons, etc). I put it in so I could monitor the satellites without
  266.    causing QRM, but it could be used as a way of shutting down a port in an
  267.    emergency.
  268.  
  269.    Setting BBSALIAS will cause connects to the port call or port alias to go
  270.    to the BBS rather than the node.
  271.  
  272.    It is not currently possible to update VALIDCALLS, but you can display
  273.    the current setting.
  274.  
  275.  
  276.    *** Warning ***  
  277.  
  278.    At the moment the FRACK value is in 1/3sec units, and the TXDELAY is in
  279.    50ms units for HDLC cards, and 10ms units for KISS TNCs. I'll be sorting
  280.    this out when I get the time to rationalize the timer code, but in the 
  281.    meantime, I suggest you make a note of the current values before you
  282.    start fiddling. 
  283.  
  284.    Also KISS users should note that the params are only sent to the TNC every
  285.    5 mins or so, so the updated values may not take effect for a while.
  286.  
  287.  
  288. ROUTES
  289.  
  290.    To display ROUTES table, enter ROUTES
  291.  
  292.    To display entry for a particular neighbour, enter ROUTES Call Port,
  293.  
  294.    eg   ROUTES G8BPQ-2 2
  295.  
  296.    To update an entry, enter ROUTES Call Port Params
  297.  
  298.    eg   ROUTES G8BPQ-2 2 100    - Set quality to 100
  299.         ROUTES G8BPQ-2 2 !         - Toggle 'Locked Route' flag
  300.         ROUTES G8BPQ-2 2 100 !     - Set quality and toggle 'locked' flag
  301.  
  302.    To clear the stats counters on a route, enter:
  303.  
  304.        ROUTES G8BPQ-2 2 Z
  305.  
  306.  
  307. SAVENODES (Not available in TSR mode).
  308.  
  309.    Writes the ROUTES and NODES tables to the BPQNODES file.
  310.  
  311.    The SAVENODES function may also be invoked directly from the DOS command
  312.    line - this function replaces BPQNODES.COM
  313.  
  314.        ie.  SYSOP SAVENODES
  315.  
  316.  
  317.  
  318. John Wiseman, G8BPQ
  319. 31.8.92
  320.